@protobuf-ts/runtime

Encoding Messages

This feature allows you to encode a Protocol Buffers message into a binary format. The code sample demonstrates how to define a message class, create an instance of the message, and encode it.

const { Message, WireType } = require('@protobuf-ts/runtime');

class MyMessage extends Message {
  static readonly runtime = { fields: [{ no: 1, name: 'field1', kind: 'scalar', T: 9 /* string */ }] };
  field1 = '';
}

const message = new MyMessage({ field1: 'Hello, World!' });
const binary = MyMessage.encode(message).finish();
console.log(binary);

Decoding Messages

This feature allows you to decode a binary Protocol Buffers message back into a message object. The code sample demonstrates how to decode a binary message into an instance of the message class.

const { Message, WireType } = require('@protobuf-ts/runtime');

class MyMessage extends Message {
  static readonly runtime = { fields: [{ no: 1, name: 'field1', kind: 'scalar', T: 9 /* string */ }] };
  field1 = '';
}

const binary = new Uint8Array([10, 13, 72, 101, 108, 108, 111, 44, 32, 87, 111, 114, 108, 100, 33]);
const message = MyMessage.decode(binary);
console.log(message);

Message Reflection

This feature provides reflection capabilities for Protocol Buffers messages, allowing you to inspect the fields and types of a message at runtime. The code sample demonstrates how to access the runtime information of a message class.

const { Message, WireType } = require('@protobuf-ts/runtime');

class MyMessage extends Message {
  static readonly runtime = { fields: [{ no: 1, name: 'field1', kind: 'scalar', T: 9 /* string */ }] };
  field1 = '';
}

const message = new MyMessage({ field1: 'Hello, World!' });
console.log(MyMessage.runtime.fields);